<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>Proxy | opine-http-proxy</title>
	<meta name="description" content="Documentation for opine-http-proxy">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">opine-http-proxy</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="../modules/_createstate_.html">&quot;createState&quot;</a>
				</li>
				<li>
					<a href="_createstate_.proxy.html">Proxy</a>
				</li>
			</ul>
			<h1>Interface Proxy</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">Proxy</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section tsd-is-not-exported">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_createstate_.proxy.html#req" class="tsd-kind-icon">req</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_createstate_.proxy.html#reqinit" class="tsd-kind-icon">req<wbr>Init</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_createstate_.proxy.html#res" class="tsd-kind-icon">res</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_createstate_.proxy.html#resdata" class="tsd-kind-icon">res<wbr>Data</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_createstate_.proxy.html#url" class="tsd-kind-icon">url</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
					<a name="req" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> req</h3>
					<div class="tsd-signature tsd-kind-icon">req<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Request</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/createState.ts#L24">home/runner/work/opine-http-proxy/opine-http-proxy/src/createState.ts:24</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
					<a name="reqinit" class="tsd-anchor"></a>
					<h3>req<wbr>Init</h3>
					<div class="tsd-signature tsd-kind-icon">req<wbr>Init<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RequestInit</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/createState.ts#L27">home/runner/work/opine-http-proxy/opine-http-proxy/src/createState.ts:27</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
					<a name="res" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> res</h3>
					<div class="tsd-signature tsd-kind-icon">res<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Response</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/createState.ts#L25">home/runner/work/opine-http-proxy/opine-http-proxy/src/createState.ts:25</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
					<a name="resdata" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> res<wbr>Data</h3>
					<div class="tsd-signature tsd-kind-icon">res<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/createState.ts#L26">home/runner/work/opine-http-proxy/opine-http-proxy/src/createState.ts:26</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
					<a name="url" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3>
					<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/createState.ts#L28">home/runner/work/opine-http-proxy/opine-http-proxy/src/createState.ts:28</a></li>
						</ul>
					</aside>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-module">
						<a href="../modules/_createstate_.html">&quot;create<wbr>State&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_isunset_.html">&quot;is<wbr>Unset&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_proxy_.html">&quot;proxy&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_requestoptions_.html">&quot;request<wbr>Options&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_resolveoptions_.html">&quot;resolve<wbr>Options&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_buildproxyreqinit_.html">&quot;steps/build<wbr>Proxy<wbr>Req<wbr>Init&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_buildproxyurl_.html">&quot;steps/build<wbr>Proxy<wbr>Url&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_copyproxyresheaderstouserres_.html">&quot;steps/copy<wbr>Proxy<wbr>Res<wbr>Headers<wbr>ToUser<wbr>Res&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decorateproxyreqinit_.html">&quot;steps/decorate<wbr>Proxy<wbr>Req<wbr>Init&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decorateproxyrequrl_.html">&quot;steps/decorate<wbr>Proxy<wbr>Req<wbr>Url&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decoratesrcres_.html">&quot;steps/decorate<wbr>Src<wbr>Res&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decoratesrcresheaders_.html">&quot;steps/decorate<wbr>Src<wbr>Res<wbr>Headers&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_filterproxyres_.html">&quot;steps/filter<wbr>Proxy<wbr>Res&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_filtersrcreq_.html">&quot;steps/filter<wbr>Src<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_handleproxyerrors_.html">&quot;steps/handle<wbr>Proxy<wbr>Errors&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_prepareproxyreq_.html">&quot;steps/prepare<wbr>Proxy<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_sendproxyreq_.html">&quot;steps/send<wbr>Proxy<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_sendsrcres_.html">&quot;steps/send<wbr>Src<wbr>Res&quot;</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-not-exported">
						<a href="_createstate_.proxy.html" class="tsd-kind-icon">Proxy</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
								<a href="_createstate_.proxy.html#req" class="tsd-kind-icon">req</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
								<a href="_createstate_.proxy.html#reqinit" class="tsd-kind-icon">req<wbr>Init</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
								<a href="_createstate_.proxy.html#res" class="tsd-kind-icon">res</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
								<a href="_createstate_.proxy.html#resdata" class="tsd-kind-icon">res<wbr>Data</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported">
								<a href="_createstate_.proxy.html#url" class="tsd-kind-icon">url</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
					<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter tsd-is-not-exported">
						<a href="_createstate_.proxyparams.html" class="tsd-kind-icon">Proxy<wbr>Params</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
						<a href="_createstate_.proxystate.html" class="tsd-kind-icon">Proxy<wbr>State</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
						<a href="_createstate_.proxyurlfunction.html" class="tsd-kind-icon">Proxy<wbr>Url<wbr>Function</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter tsd-is-not-exported">
						<a href="_createstate_.source.html" class="tsd-kind-icon">Source</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
						<a href="../modules/_createstate_.html#createstate" class="tsd-kind-icon">create<wbr>State</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>